fix: restore ability to disable color correct rendering #15898

poiru · 2018-11-30T12:35:42Z

In Electron 2.0, --disable-features=ColorCorrectRendering could be
used to make the app use the display color space (e.g. P3 on Macs)
instead of color correcting to sRGB. Because color correct rendering is
always enabled on Chromium 62 and later and because
--force-color-profile has no effect on macOS, apps that need e.g. P3
colors are currently stuck on Electron 2.0.

This restores the functionality removed in
https://chromium-review.googlesource.com/698347 in the form of the
--disable-color-correct-rendering switch.

This can be removed once web content (including WebGL) learn how
to deal with color spaces. That is being tracked at
https://crbug.com/634542 and https://crbug.com/711107.

As an example of a widely used app using
--disable-features=ColorCorrectRendering, see VSCode:
https://github.com/Microsoft/vscode/blob/3f33ef2593d3efe6eca5230f3d34d3406fb73498/src/main.js#L138-L139

Notes: Add --disable-color-correct-rendering switch

poiru · 2018-11-30T12:39:08Z

I confirmed that #FF0000 with disable-color-correct-rendering are more saturated on a Mac with a P3 display. I checked colors generated with WebGL, CSS, and a PNG image. Here's the code:

main.js:

const { app, BrowserWindow } = require('electron');

app.commandLine.appendSwitch('disable-color-correct-rendering');

let win = null;

app.once('ready', () => {
  win = new BrowserWindow({
    width: 300,
    height: 600,
    webPreferences: {
      nodeIntegration: false
    }
  });

  win.loadURL(`file://${__dirname}/test.html`);
});

test.html:

<html>
<head>
  <meta http-equiv="Content-Security-Policy" content="default-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self' 'unsafe-inline'; img-src 'self' data:">
  <style>
  body, html {
    width: 100%;
    height: 100%;
    font-family: sans-serif;
    font-size: 10px;
  }
  canvas, div, img {
    width: 100px;
    height: 100px;
    border: 2px solid black;
  }
  </style>
</head>
<body>
  <p>webgl canvas</p>
  <canvas></canvas>
  <p>css</p>
  <div style="background-color: red"></div>
  <p>img</p>
  <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX/AAAZ4gk3AAAACklEQVR4nGNiAAAABgADNjd8qAAAAABJRU5ErkJggg=="/>
  <p id="ua"></p>
</body>
<script>
window.addEventListener('load', () => {
  var canvas = document.querySelector('canvas');
  var gl = canvas.getContext('webgl');
  gl.viewport(0, 0, gl.drawingBufferWidth, gl.drawingBufferHeight);
  gl.clearColor(1.0, 0.0, 0.0, 1.0);
  gl.clear(gl.COLOR_BUFFER_BIT);

  document.querySelector('#ua').innerHTML = navigator.userAgent;
}, false);
</script>

nornagon

It is far from clear to me that this patches all the necessary places, and I'm concerned about continuing support for this flag in the face of future upstream refactors in Chrome's rendering code, but I'm satisfied that at least for this particular version of Chrome that this patch does not change behaviour unless you pass the flag, so I'm approving anyway.

Please be prepared for this flag to get disabled in a future chrome upgrade if you're not around to help port it :)

nornagon · 2018-12-03T22:05:46Z

patches/common/chromium/disable_color_correct_rendering.patch

+   RendererSettings renderer_settings;
+   base::CommandLine* command_line = base::CommandLine::ForCurrentProcess();
+  renderer_settings.enable_color_correct_rendering =
+      !command_line->HasSwitch("disable-color-correct-rendering");


please add a string constant kDisableColorCorrectRendering so that typos will be a compile error :)

In Electron 2.0, `--disable-features=ColorCorrectRendering` could be used to make the app use the display color space (e.g. P3 on Macs) instead of color correcting to sRGB. Because color correct rendering is always enabled on Chromium 62 and later and because `--force-color-profile` has no effect on macOS, apps that need e.g. P3 colors are currently stuck on Electron 2.0. This restores the functionality removed in https://chromium-review.googlesource.com/698347 in the form of the `--disable-color-correct-rendering` switch. This can be removed once web content (including WebGL) learn how to deal with color spaces. That is being tracked at https://crbug.com/634542 and https://crbug.com/711107. As an example of a widely used app using `--disable-features=ColorCorrectRendering`, see VSCode: https://github.com/Microsoft/vscode/blob/3f33ef2593d3efe6eca5230f3d34d3406fb73498/src/main.js#L138-L139 Notes: Add `--disable-color-correct-rendering` switch

release-clerk · 2018-12-11T16:06:23Z

Release Notes Persisted

Add --disable-color-correct-rendering switch

trop · 2018-12-11T16:06:49Z

I was unable to backport this PR to "3-1-x" cleanly;
you will need to perform this backport manually.

trop · 2018-12-11T16:06:53Z

I was unable to backport this PR to "4-0-x" cleanly;
you will need to perform this backport manually.

…0-x) Backport of #15898 See that PR for details. Notes: Add `--disable-color-correct-rendering` switch

…0-x) (#16020) Backport of #15898 See that PR for details. Notes: Add `--disable-color-correct-rendering` switch

bpasero · 2019-01-04T12:23:07Z

@poiru did this ever land on 3-0-x?

This broke in Electron 6 due to some Chromium changes. Test Plan: - Confirm that test case from electron#15898 (comment) now works Notes: Fix disabling color correct rendering with `--disable-color-correct-rendering`

…20356) This broke in Electron 6 due to some Chromium changes. Test Plan: - Confirm that test case from #15898 (comment) now works Notes: Fix disabling color correct rendering with `--disable-color-correct-rendering`

This regressed once again in Electron 8 due to Chromium changes. Test Plan: - Confirm that test case from electron#15898 (comment) now works Notes: Fix disabling color correct rendering with `--disable-color-correct-rendering`

…23787) This regressed once again in Electron 8 due to Chromium changes. Test Plan: - Confirm that test case from #15898 (comment) now works Notes: Fix disabling color correct rendering with `--disable-color-correct-rendering`

This regressed once again in Electron 8 due to Chromium changes. Test Plan: - Confirm that test case from #15898 (comment) now works Notes: Fix disabling color correct rendering with `--disable-color-correct-rendering`

…23899) This regressed once again in Electron 8 due to Chromium changes. Test Plan: - Confirm that test case from #15898 (comment) now works Notes: Fix disabling color correct rendering with `--disable-color-correct-rendering` Co-authored-by: Biru Mohanathas <birunthan@mohanathas.com>

…23900) * fix: Make the `--disable-color-correct-rendering` switch work again This regressed once again in Electron 8 due to Chromium changes. Test Plan: - Confirm that test case from #15898 (comment) now works Notes: Fix disabling color correct rendering with `--disable-color-correct-rendering` * update patches Co-authored-by: Biru Mohanathas <birunthan@mohanathas.com> Co-authored-by: Electron Bot <anonymous@electronjs.org>

poiru requested review from nornagon and a team November 30, 2018 12:35

poiru force-pushed the disable-color-correct-rendering branch from 7c77850 to 8a88557 Compare November 30, 2018 12:36

poiru mentioned this pull request Nov 30, 2018

fix: restore ability to disable color correct rendering (superseded) #15893

Closed

poiru force-pushed the disable-color-correct-rendering branch from 8a88557 to fd56b87 Compare December 3, 2018 20:10

nornagon approved these changes Dec 10, 2018

View reviewed changes

poiru added target/4-0-x labels Dec 11, 2018

poiru force-pushed the disable-color-correct-rendering branch from fd56b87 to 3af9274 Compare December 11, 2018 12:01

deepak1556 approved these changes Dec 11, 2018

View reviewed changes

deepak1556 merged commit e383aa3 into master Dec 11, 2018

deepak1556 deleted the disable-color-correct-rendering branch December 11, 2018 16:06

poiru added a commit that referenced this pull request Dec 11, 2018

fix: restore ability to disable color correct rendering (backport: 4-…

42d3439

…0-x) Backport of #15898 See that PR for details. Notes: Add `--disable-color-correct-rendering` switch

poiru mentioned this pull request Dec 11, 2018

fix: restore ability to disable color correct rendering (backport: 4-0-x) #16020

Merged

ckerr pushed a commit that referenced this pull request Dec 11, 2018

fix: restore ability to disable color correct rendering (backport: 4-…

388197d

…0-x) (#16020) Backport of #15898 See that PR for details. Notes: Add `--disable-color-correct-rendering` switch

bpasero mentioned this pull request Feb 7, 2019

Electron 3.0.x: Pale/desaturated colors microsoft/vscode#68001

Closed

shiftkey mentioned this pull request Mar 14, 2019

Colours after update desktop/desktop#7021

Closed

poiru mentioned this pull request Sep 27, 2019

fix: Make the --disable-color-correct-rendering switch work again #20356

Merged

poiru mentioned this pull request May 27, 2020

fix: Make the --disable-color-correct-rendering switch work again #23787

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: restore ability to disable color correct rendering #15898

fix: restore ability to disable color correct rendering #15898

poiru commented Nov 30, 2018

poiru commented Nov 30, 2018 •

edited

nornagon left a comment

nornagon Dec 3, 2018

poiru Dec 11, 2018

release-clerk bot commented Dec 11, 2018

trop bot commented Dec 11, 2018

trop bot commented Dec 11, 2018

bpasero commented Jan 4, 2019

fix: restore ability to disable color correct rendering #15898

fix: restore ability to disable color correct rendering #15898

Conversation

poiru commented Nov 30, 2018

poiru commented Nov 30, 2018 • edited

nornagon left a comment

Choose a reason for hiding this comment

nornagon Dec 3, 2018

Choose a reason for hiding this comment

poiru Dec 11, 2018

Choose a reason for hiding this comment

release-clerk bot commented Dec 11, 2018

trop bot commented Dec 11, 2018

trop bot commented Dec 11, 2018

bpasero commented Jan 4, 2019

poiru commented Nov 30, 2018 •

edited